{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "ba2b78cd",
   "metadata": {},
   "source": [
    "# 사용자 요구사항 기반 메타 프롬프트 생성 에이전트\n",
    "\n",
    "이 튜토리얼에서는 사용자가 프롬프트를 생성할 수 있도록 돕는 챗봇을 만드는 방법을 설명합니다. 챗봇은 먼저 사용자로부터 요구사항을 수집한 후, 이를 바탕으로 프롬프트를 생성하고 사용자 입력에 따라 이를 수정합니다. 이 과정은 두 개의 별도 상태로 나뉘며, LLM이 상태 전환 시점을 결정합니다.\n",
    "\n",
    "이 시스템의 그래픽 표현은 아래에서 확인할 수 있습니다.\n",
    "\n",
    "**주로 다루는 내용**\n",
    "\n",
    "- **Gather information**: 사용자 요구사항 수집을 위한 그래프 정의\n",
    "- **Generate Prompt**: 프롬프트 생성을 위한 상태 설정\n",
    "- **Define the state logic**: 챗봇의 상태 논리 정의\n",
    "- **Create the graph**: 그래프 생성 및 대화 기록 저장\n",
    "- **Use the graph**: 생성된 챗봇 사용 방법\n",
    "\n",
    "이 예제에서는 사용자가 프롬프트를 생성할 수 있도록 돕는 챗봇을 만듭니다. \n",
    "\n",
    "챗봇은 먼저 사용자로부터 요구사항을 수집한 후, 이를 바탕으로 프롬프트를 생성하고 사용자 입력에 따라 이를 수정합니다. \n",
    "\n",
    "이 과정은 두 개의 별도 상태로 나뉘며, LLM이 상태 전환 시점을 결정합니다.\n",
    "\n",
    "시스템의 그래픽 표현은 아래에서 확인할 수 있습니다.\n",
    "\n",
    "![meta-prompt-generator.png](assets/meta-prompt-generator.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f9ffd226",
   "metadata": {},
   "source": [
    "## 환경 설정"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "c4d6c0f3",
   "metadata": {},
   "outputs": [],
   "source": [
    "# API 키를 환경변수로 관리하기 위한 설정 파일\n",
    "from dotenv import load_dotenv\n",
    "\n",
    "# API 키 정보 로드\n",
    "load_dotenv()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "368dea81",
   "metadata": {},
   "outputs": [],
   "source": [
    "# LangSmith 추적을 설정합니다. https://smith.langchain.com\n",
    "# !pip install -qU langchain-teddynote\n",
    "from langchain_teddynote import logging\n",
    "\n",
    "# 프로젝트 이름을 입력합니다.\n",
    "logging.langsmith(\"CH17-LangGraph-Use-Cases\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e65d330b",
   "metadata": {},
   "source": [
    "## 사용자로부터 요구사항 수집\n",
    "\n",
    "먼저, 사용자 요구사항을 수집하는 노드를 정의합니다.\n",
    "\n",
    "이 과정에서 사용자에게 구체적인 정보를 요구할 수 있습니다. 필요한 정보가 모두 **충족** 될 때까지 사용자에게 필요한 정보를 요구합니다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "fb32ec35",
   "metadata": {},
   "outputs": [],
   "source": [
    "from typing import List\n",
    "from langchain_core.messages import SystemMessage\n",
    "from langchain_openai import ChatOpenAI\n",
    "from pydantic import BaseModel\n",
    "from langchain_teddynote.models import get_model_name, LLMs\n",
    "\n",
    "# 사용자 요구사항 수집을 위한 시스템 메시지 템플릿\n",
    "template = \"\"\"Your job is to get information from a user about what type of prompt template they want to create.\n",
    "\n",
    "You should get the following information from them:\n",
    "\n",
    "- What the objective of the prompt is\n",
    "- What variables will be passed into the prompt template\n",
    "- Any constraints for what the output should NOT do\n",
    "- Any requirements that the output MUST adhere to\n",
    "\n",
    "If you are not able to discern this info, ask them to clarify! Do not attempt to wildly guess.\n",
    "\n",
    "After you are able to discern all the information, call the relevant tool.\n",
    "\n",
    "[IMPORTANT] Your conversation should be in Korean. Your generated prompt should be in English.\"\"\"\n",
    "\n",
    "\n",
    "# 사용자 메시지 목록을 받아 시스템 메시지와 결합하여 반환\n",
    "def get_messages_info(messages):\n",
    "    # 사용자 요구사항 수집을 위한 시스템 메시지와 기존 메시지 결합\n",
    "    return [SystemMessage(content=template)] + messages\n",
    "\n",
    "\n",
    "# LLM에 대한 프롬프트 지침을 정의하는 데이터 모델\n",
    "class PromptInstructions(BaseModel):\n",
    "    \"\"\"Instructions on how to prompt the LLM.\"\"\"\n",
    "\n",
    "    # 프롬프트의 목표\n",
    "    objective: str\n",
    "    # 프롬프트 템플릿에 전달될 변수 목록\n",
    "    variables: List[str]\n",
    "    # 출력에서 피해야 할 제약 조건 목록\n",
    "    constraints: List[str]\n",
    "    # 출력이 반드시 따라야 할 요구 사항 목록\n",
    "    requirements: List[str]\n",
    "\n",
    "\n",
    "# 최신 LLM 모델 이름 가져오기\n",
    "MODEL_NAME = get_model_name(LLMs.GPT4)\n",
    "# LLM 초기화\n",
    "llm = ChatOpenAI(temperature=0, model=MODEL_NAME)\n",
    "# PromptInstructions 구조체를 바인딩\n",
    "llm_with_tool = llm.bind_tools([PromptInstructions])\n",
    "\n",
    "\n",
    "# 상태 정보를 기반으로 메시지 체인을 생성하고 LLM 호출\n",
    "def info_chain(state):\n",
    "    # 상태에서 메시지 정보를 가져와 시스템 메시지와 결합\n",
    "    messages = get_messages_info(state[\"messages\"])\n",
    "    # LLM을 호출하여 응답 생성\n",
    "    response = llm_with_tool.invoke(messages)\n",
    "    # 생성된 응답을 메시지 목록으로 반환\n",
    "    return {\"messages\": [response]}"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9f314f44",
   "metadata": {},
   "source": [
    "## 프롬프트 생성\n",
    "\n",
    "이제 프롬프트를 생성할 상태를 설정합니다. \n",
    "\n",
    "이를 위해 별도의 시스템 메시지가 필요하며, 도구 호출 이전의 모든 메시지를 필터링하는 함수도 필요합니다.\n",
    "\n",
    "여기서 우리가 활용하는 메타 프롬프트의 정의는 아래와 같습니다.\n",
    "\n",
    "**메타 프롬프트(Meta Prompt)의 정의**\n",
    "\n",
    "메타 프롬프트(Meta Prompt)는 **프롬프트 설계 및 생성 자체를 최적화하기 위한 방법론이나 전략**을 지칭하는 개념으로, 인공지능 언어 모델(LLM)을 보다 효과적이고 효율적으로 활용하기 위해 사용됩니다. 단순히 텍스트를 입력하는 것을 넘어, **모델의 반응을 특정 방식으로 유도하거나, 결과의 품질을 높이는 데 필요한 구조적이고 창의적인 접근**을 포함합니다.\n",
    "\n",
    "**주요 특징**\n",
    "\n",
    "1. **목표 지향적 구조**  \n",
    "   메타 프롬프트는 결과로 얻고자 하는 정보를 명확히 정의하고, 이를 위한 단계별 설계 과정을 포함합니다.\n",
    "\n",
    "2. **적응형 설계**  \n",
    "   모델의 답변 특성, 한계, 강점을 고려하여 프롬프트를 수정하거나 반복적으로 최적화하는 접근 방식을 포함합니다.\n",
    "\n",
    "3. **프롬프트 엔지니어링 활용**  \n",
    "   조건문, 가이드라인, 역할 지시 등을 포함하여 모델의 응답을 세밀하게 조정합니다.\n",
    "\n",
    "4. **다층적 접근**  \n",
    "   단일 질문에 그치지 않고, 하위 질문을 통해 답변을 점진적으로 구체화하는 방식을 채택합니다.\n",
    "\n",
    "\n",
    "- 참고: [OpenAI 메타 프롬프트 엔지니어링 가이드](https://platform.openai.com/docs/guides/prompt-generation?context=text-out)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "3564d908",
   "metadata": {},
   "outputs": [],
   "source": [
    "from langchain_core.messages import AIMessage, HumanMessage, ToolMessage, SystemMessage\n",
    "\n",
    "# 프롬프트를 생성하는 메타 프롬프트 정의(OpenAI 메타 프롬프트 엔지니어링 가이드 참고)\n",
    "META_PROMPT = \"\"\"Given a task description or existing prompt, produce a detailed system prompt to guide a language model in completing the task effectively.\n",
    "\n",
    "# Guidelines\n",
    "\n",
    "- Understand the Task: Grasp the main objective, goals, requirements, constraints, and expected output.\n",
    "- Minimal Changes: If an existing prompt is provided, improve it only if it's simple. For complex prompts, enhance clarity and add missing elements without altering the original structure.\n",
    "- Reasoning Before Conclusions**: Encourage reasoning steps before any conclusions are reached. ATTENTION! If the user provides examples where the reasoning happens afterward, REVERSE the order! NEVER START EXAMPLES WITH CONCLUSIONS!\n",
    "    - Reasoning Order: Call out reasoning portions of the prompt and conclusion parts (specific fields by name). For each, determine the ORDER in which this is done, and whether it needs to be reversed.\n",
    "    - Conclusion, classifications, or results should ALWAYS appear last.\n",
    "- Examples: Include high-quality examples if helpful, using placeholders [in brackets] for complex elements.\n",
    "   - What kinds of examples may need to be included, how many, and whether they are complex enough to benefit from placeholders.\n",
    "- Clarity and Conciseness: Use clear, specific language. Avoid unnecessary instructions or bland statements.\n",
    "- Formatting: Use markdown features for readability. DO NOT USE ``` CODE BLOCKS UNLESS SPECIFICALLY REQUESTED.\n",
    "- Preserve User Content: If the input task or prompt includes extensive guidelines or examples, preserve them entirely, or as closely as possible. If they are vague, consider breaking down into sub-steps. Keep any details, guidelines, examples, variables, or placeholders provided by the user.\n",
    "- Constants: DO include constants in the prompt, as they are not susceptible to prompt injection. Such as guides, rubrics, and examples.\n",
    "- Output Format: Explicitly the most appropriate output format, in detail. This should include length and syntax (e.g. short sentence, paragraph, JSON, etc.)\n",
    "    - For tasks outputting well-defined or structured data (classification, JSON, etc.) bias toward outputting a JSON.\n",
    "    - JSON should never be wrapped in code blocks (```) unless explicitly requested.\n",
    "\n",
    "The final prompt you output should adhere to the following structure below. Do not include any additional commentary, only output the completed system prompt. SPECIFICALLY, do not include any additional messages at the start or end of the prompt. (e.g. no \"---\")\n",
    "\n",
    "[Concise instruction describing the task - this should be the first line in the prompt, no section header]\n",
    "\n",
    "[Additional details as needed.]\n",
    "\n",
    "[Optional sections with headings or bullet points for detailed steps.]\n",
    "\n",
    "# Steps [optional]\n",
    "\n",
    "[optional: a detailed breakdown of the steps necessary to accomplish the task]\n",
    "\n",
    "# Output Format\n",
    "\n",
    "[Specifically call out how the output should be formatted, be it response length, structure e.g. JSON, markdown, etc]\n",
    "\n",
    "[User given variables should be wrapped in {{brackets}}]\n",
    "\n",
    "<Question>\n",
    "{{question}}\n",
    "</Question>\n",
    "\n",
    "<Answer>\n",
    "{{answer}}\n",
    "</Answer>\n",
    "\n",
    "# Examples [optional]\n",
    "\n",
    "[Optional: 1-3 well-defined examples with placeholders if necessary. Clearly mark where examples start and end, and what the input and output are. User placeholders as necessary.]\n",
    "[If the examples are shorter than what a realistic example is expected to be, make a reference with () explaining how real examples should be longer / shorter / different. AND USE PLACEHOLDERS! ]\n",
    "\n",
    "# Notes [optional]\n",
    "\n",
    "[optional: edge cases, details, and an area to call or repeat out specific important considerations]\n",
    "\n",
    "# Based on the following requirements, write a good prompt template:\n",
    "\n",
    "{reqs}\n",
    "\"\"\"\n",
    "\n",
    "\n",
    "# 프롬프트 생성을 위한 메시지 가져오기 함수\n",
    "# 도구 호출 이후의 메시지만 가져옴\n",
    "def get_prompt_messages(messages: list):\n",
    "    # 도구 호출 정보를 저장할 변수 초기화\n",
    "    tool_call = None\n",
    "    # 도구 호출 이후의 메시지를 저장할 리스트 초기화\n",
    "    other_msgs = []\n",
    "    # 메시지 목록을 순회하며 도구 호출 및 기타 메시지 처리\n",
    "    for m in messages:\n",
    "        # AI 메시지 중 도구 호출이 있는 경우 도구 호출 정보 저장\n",
    "        if isinstance(m, AIMessage) and m.tool_calls:\n",
    "            tool_call = m.tool_calls[0][\"args\"]\n",
    "        # ToolMessage는 건너뜀\n",
    "        elif isinstance(m, ToolMessage):\n",
    "            continue\n",
    "        # 도구 호출 이후의 메시지를 리스트에 추가\n",
    "        elif tool_call is not None:\n",
    "            other_msgs.append(m)\n",
    "    # 시스템 메시지와 도구 호출 이후의 메시지를 결합하여 반환\n",
    "    return [SystemMessage(content=META_PROMPT.format(reqs=tool_call))] + other_msgs\n",
    "\n",
    "\n",
    "# 프롬프트 생성 체인 함수 정의\n",
    "def prompt_gen_chain(state):\n",
    "    # 상태에서 프롬프트 메시지를 가져옴\n",
    "    messages = get_prompt_messages(state[\"messages\"])\n",
    "    # LLM을 호출하여 응답 생성\n",
    "    response = llm.invoke(messages)\n",
    "    # 생성된 응답을 메시지 목록으로 반환\n",
    "    return {\"messages\": [response]}"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c9c4d636",
   "metadata": {},
   "source": [
    "## 상태 논리 정의\n",
    "\n",
    "챗봇의 상태를 결정하는 논리를 설명합니다.\n",
    "\n",
    "- 마지막 메시지가 `tool call`인 경우, \"prompt creator\"(`prompt`)가 응답해야 하는 상태에 있습니다.\n",
    "- 마지막 메시지가 `HumanMessage`가 아닌 경우, 사용자가 다음에 응답해야 하므로 `END` 상태에 있습니다.\n",
    "- 마지막 메시지가 `HumanMessage`인 경우, 이전에 `tool call`이 있었다면 `prompt` 상태에 있습니다.\n",
    "- 그렇지 않으면 \"정보 수집\"(`info`) 상태에 있습니다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "e725b748",
   "metadata": {},
   "outputs": [],
   "source": [
    "from langgraph.graph import END\n",
    "\n",
    "\n",
    "# 상태 결정 함수 정의\n",
    "# 상태에서 메시지 목록을 가져옴\n",
    "def get_state(state):\n",
    "    messages = state[\"messages\"]\n",
    "    # 마지막 메시지가 AIMessage이고 도구 호출이 있는 경우\n",
    "    if isinstance(messages[-1], AIMessage) and messages[-1].tool_calls:\n",
    "        # 도구 메시지를 추가해야 하는 상태 반환\n",
    "        return \"add_tool_message\"\n",
    "    # 마지막 메시지가 HumanMessage가 아닌 경우\n",
    "    elif not isinstance(messages[-1], HumanMessage):\n",
    "        # 대화 종료 상태 반환\n",
    "        return END\n",
    "    # 기본적으로 정보 수집 상태 반환\n",
    "    return \"info\""
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3f3150ab",
   "metadata": {},
   "source": [
    "## 그래프 생성\n",
    "\n",
    "이제 그래프를 생성할 수 있습니다. 대화 기록을 저장하기 위해 `MemorySaver`를 사용할 것입니다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "2e03b383",
   "metadata": {},
   "outputs": [],
   "source": [
    "from langgraph.checkpoint.memory import MemorySaver\n",
    "from langgraph.graph import StateGraph, START, END\n",
    "from langchain_core.messages import ToolMessage\n",
    "from langgraph.graph.message import add_messages\n",
    "from typing import Annotated\n",
    "from typing_extensions import TypedDict\n",
    "\n",
    "\n",
    "# State 정의\n",
    "class State(TypedDict):\n",
    "    messages: Annotated[list, add_messages]\n",
    "\n",
    "\n",
    "# 메모리에 대화 기록을 저장하기 위한 MemorySaver 초기화\n",
    "memory = MemorySaver()\n",
    "\n",
    "# 상태 그래프 초기화\n",
    "workflow = StateGraph(State)\n",
    "\n",
    "# 노드 추가\n",
    "workflow.add_node(\"info\", info_chain)\n",
    "workflow.add_node(\"prompt\", prompt_gen_chain)\n",
    "\n",
    "\n",
    "# 도구 메시지 추가 상태 노드 정의\n",
    "@workflow.add_node\n",
    "def add_tool_message(state: State):\n",
    "    return {\n",
    "        \"messages\": [\n",
    "            ToolMessage(\n",
    "                content=\"Prompt generated!\",\n",
    "                tool_call_id=state[\"messages\"][-1].tool_calls[0][\n",
    "                    \"id\"\n",
    "                ],  # 상태에서 도구 호출 ID를 가져와 메시지에 추가\n",
    "            )\n",
    "        ]\n",
    "    }\n",
    "\n",
    "\n",
    "# 조건부 상태 전환 정의\n",
    "workflow.add_conditional_edges(\"info\", get_state, [\"add_tool_message\", \"info\", END])\n",
    "\n",
    "# 엣지 정의\n",
    "workflow.add_edge(\"add_tool_message\", \"prompt\")\n",
    "workflow.add_edge(\"prompt\", END)\n",
    "workflow.add_edge(START, \"info\")\n",
    "\n",
    "# 그래프 컴파일\n",
    "graph = workflow.compile(checkpointer=memory)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ea9d8b24",
   "metadata": {},
   "source": [
    "그래프를 시각화합니다.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "cfec101f",
   "metadata": {},
   "outputs": [],
   "source": [
    "from langchain_teddynote.graphs import visualize_graph\n",
    "\n",
    "visualize_graph(graph)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8e3849ce",
   "metadata": {},
   "source": [
    "## 실행\n",
    "\n",
    "이제 생성한 그래프를 실행하여 프롬프트를 생성합니다."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d0c97d77",
   "metadata": {},
   "outputs": [],
   "source": [
    "import uuid\n",
    "from langchain_teddynote.messages import stream_graph\n",
    "\n",
    "# 구성 설정 초기화 (고유한 thread_id 생성)\n",
    "config = {\"configurable\": {\"thread_id\": str(uuid.uuid4())}}\n",
    "\n",
    "# 무한 루프 시작\n",
    "while True:\n",
    "    try:\n",
    "        # 사용자 입력 받기\n",
    "        user = input(\"User (q/Q to quit): \")\n",
    "    except:\n",
    "        pass\n",
    "\n",
    "    # 사용자 입력 출력\n",
    "    print(f\"\\n\\033[93m[사용자] {user}\\033[0m\")\n",
    "\n",
    "    # 'q' 또는 'Q' 입력 시 루프 종료\n",
    "    if user in {\"q\", \"Q\"}:\n",
    "        print(\"AI: 다음에 또 만나요!\")\n",
    "        break\n",
    "\n",
    "    # 출력 변수 초기화\n",
    "    output = None\n",
    "\n",
    "    stream_graph(\n",
    "        graph,\n",
    "        {\"messages\": [HumanMessage(content=user)]},\n",
    "        config=config,\n",
    "        node_names=[\"info\", \"prompt\"],\n",
    "    )"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "langchain-kr-lwwSZlnu-py3.11",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.10"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}
